home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / wc3x / wca3xv2.zip / WCA3X.DOC < prev    next >
Text File  |  1992-10-03  |  11KB  |  263 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                       D O C U M E N T A T I O N    F O R
  8.  
  9.  
  10.                            Wildcat! 3 Analyzer V2.0
  11.                             for Caller Statistics
  12.                            ========================
  13.                              by Larry E. Hardeman
  14.  
  15.  
  16.  
  17.                           Hardeman's  Christian BBS
  18.                              1734 Fairview Drive
  19.                             Moody, AL       35004
  20.                              Voice:(205)640-7581
  21.                               BBS:(205)640-6436
  22.                                24hrs 1200/2400
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31. ==============================================================================
  32. This program is Shareware and may be distributed freely to friends and other
  33. BBS's.  You may use this software for a evaluation period of 30 days. If after
  34. the end of 30 days and you want to continue using it, you are expected to send
  35. a $10.00 registration fee to the above address.  At that time, I will make
  36. available a special ID file and upload it to your board.  The ID file will be
  37. able to be used in all future releases of this program. For more details, see
  38. the order form file ORDER.FRM for placing orders.          -Thank you.
  39. ==============================================================================
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.                                                          WC3 Analyzer - Page 1
  48.  
  49. INTRODUCTION:
  50. =============
  51.  
  52. I am not held resposible for misuse of this program and damage of any data
  53. files on your system.  You are required to have a knowledge of setting up
  54. batch files and the use of the Wildcat! configuration program MAKEWILD.EXE
  55. to properly maintain your system.  Read all instructions carefully and you
  56. should not have any problems with the installation.
  57.  
  58. Wildcat! 3 Analyzer is a program that compiles the caller stats for Wildcat!
  59. Version 3.x Bulletin Boards to BULLX.BBS files.  The bulletins use the special
  60. @COLOR@ color codes for Wildcat BBS's, thus eliminating the need for an ASCII
  61. file and and ANSI file for each bulletin.
  62.  
  63. Six bulletins are made, Last Ten Callers, Top Callers, Top Message Writers,
  64. Top Uploaders, Top Downloaders and Hours of Board Use.  Information is
  65. retreived from the DOOR.SYS file when a call is terminated via use of the
  66. POSTCALL.BAT or POSTCALL.RUN batch files. For multi-node systems, each work
  67. directory (ie, c:\wc30\wcwork\node1....node5) is required to have it's own
  68. configuration file and POSTCALL.BAT procedure and the program is to be
  69. launched from that directory.
  70.  
  71. Below are a listing of the files included needed to be a complete package
  72. and should be intact on all distribution copies of this software.
  73.  
  74.             WCA3X.EXE       The program.
  75.             WCA3X.CFG       A sample configuration program.
  76.             WCA3X.DOC       This documentation.
  77.             POSTCALL.RUN    A sample batch for use in the work directory.
  78.             WCA3X.LST       A list of names to exclude from bulletins.
  79.             1TO2CNGS.TXT    Changes from v1.0 to v2.0
  80.  
  81.  
  82. UPGRADING FROM VERSION 1.0:
  83. ===========================
  84.  
  85. Very little needs to be done to make the change over from version 1.0 to this
  86. version.
  87.  
  88.      1.  First thing, copy WCA3X.EXE, WCA3X.DOC, WCA3X.LST and 1TO2CHGS.TXT
  89.          to your WILDCAT! work directory (most likely C:\WC30).
  90.      2.  Modify your existing WCA3X.LST to match the one in the following
  91.          Installation procedures.
  92.      3.  Make the WCA3X.LST file and place it in the Wildcat WORK directory.
  93.          The file must have at least one name in it, even if it is a dummy
  94.          name.
  95.      4.  Run the WCA3X.EXE program from a NODE directory with the parameter
  96.          /rt as outlined in the Final Procedures on page 4.
  97.  
  98. This should be all you need to do. I do suggest that you do take the time to
  99. read all of this document.
  100.  
  101.  
  102. INSTALLATION:
  103. =============
  104.  
  105. Installation is quite simple and a single line system should be up and
  106. running in a matter of minutes.  As a matter of fact, it will probably take
  107. you longer to read all this than actually set up the software.
  108.  
  109. First step, make sure you have all the files listed above.  We will now edit
  110. the configuration file using your favorite line editor (I like TED). Below
  111. is how the configuration file (WCA3X.CFG) is layed out.  This file(s) is to be
  112. placed in each node directory for multi-node systems so the program may know
  113. where to look for the DOOR.SYS file.
  114.  
  115. NO                                                      ;Use Local Logons
  116. c:\wc30                                                 ;Home Directory
  117. c:\wc30\wcwork\node1                                    ;Node Directory
  118. c:\wc30\bull\bull7.bbs                                  ;Top 10 Callers
  119. c:\wc30\bull\bull8.bbs                                  ;Top 10 Messagers
  120. c:\wc30\bull\bull9.bbs                                  ;Top 10 Uploaders
  121. c:\wc30\bull\bull10.bbs                                 ;Top 10 Downloaders
  122. c:\wc30\bull\bull6.bbs                                  ;Last 10 Callers
  123. c:\wc30\bull\bull11.bbs                                 ;Hours of use
  124. Messages Started 02-02-92     Files Started 05-27-91    ;Remark Line 1
  125. Above callers have called since 02-12-92.               ;Remark Line 2
  126.  
  127. When you modify the above file, make sure you don't put any ";" in a line
  128. other than the ones noted. These are used to represent a remark. There must
  129. be 11 lines as shown in the WCA3X.CFG file and this file needs to be copied
  130. to each node work directory. (ie  C:\WC30\WCWORK\NODEx)
  131.  
  132.  
  133.                                                          WC3 Analyzer - Page 2
  134.  
  135. Use Local Logons    If this is set to NO, all local logons will be ignored
  136.                     and no bulletins will be updated.
  137.  
  138. Home Directory      This is the location of the WCA3X.EXE and WCA3X.ID (if you
  139.                     are registered) and it should be the same directory that
  140.                     your Wildcat! 3 program resides.
  141.  
  142. Work Directory      The working directory for each specific node.  This is
  143.                     where Wildcat! places the DOOR.SYS file for a drop to DOS
  144.                     or DOS hooks. You should place a specific WCA3X.CFG file
  145.                     in each work directory along with the proper POSTCALL.RUN
  146.                     batch file (see the Wildcat! users manual for details).
  147.  
  148. Bulletin Directory  This is the directory where your bulletins are located.
  149.  
  150. Next 6 Lines        These are rather obvious. You need to place on each line,
  151.                     in order, as shown above the bulletin names of bulletins
  152.                     to be used.  If you choose not to use a specific bulletin,
  153.                     just give it a dummy name to prevent it from being read
  154.                     by Wildcat!.  ALL LINES MUST BE USED!!!
  155.  
  156. Remark 1 & 2        The last 2 lines are remark lines that will appear at the
  157.                     bottom of each bulletin and can be up to 73 characters in
  158.                     length.  I use these to let folks know what dates each
  159.                     statistic category was originated.  You may place anything
  160.                     you wish here, or simply place a carriage return for no
  161.                     remarks.
  162.  
  163.  
  164.                                                          WC3 Analyzer - Page 3
  165.  
  166. The WCA3X.LST file
  167. ==================
  168.  
  169. This file contains names that you don't want bulletins generated for. It will
  170. only tabulate the call in the Hours of Use bulletin, unless it is a local
  171. call.  The file can contain up to 100 lines, on each line there MUST be a
  172. users name. The primary use of this file is to keep from tabulating the
  173. Sysop and NetMail users in the bulletins. It is up to you whether or not
  174. you use it, but it must be located in the WORK DIRECTORY and contain at least
  175. one name. Here is a sample file:
  176.  
  177. Larry Hardeman
  178. Hc Bbs
  179. Pooh Bbs
  180. Cab Bbs
  181. Family Bbs
  182.  
  183.  
  184.  
  185. POSTCALL.BAT (or POSTCALL.RUN
  186. =============================
  187.  
  188. Now for the oh so confusing POSCTALL.BAT or POSTCALL.RUN batch file.  There
  189. are 2 methods of using batch files for DOS Hooks.  You are required to have
  190. a knowledge of these, and each depends on whether you allow a terminated on
  191. Doors and Menu Hooks in the MAKEWILD.EXE program.  I suggest you answer "N"
  192. to this prompt and let Wildcat! shell to another copy of the command.com
  193. file.  The examples I will give are for this set-up, and will be using the
  194. POSTCALL.RUN batch instead of the POSTCALL.BAT which is used if you have
  195. answered "Y" to the terminated on Doors and Menu Hooks.
  196.  
  197. Below you will see a simple POSTCALL.RUN batch file that must be made up and
  198. placed in each work directory for each node.  Notice that there is no line
  199. calling Wildcat! back, this is because we shelled instead of terminated.
  200.  
  201.         @echo off       ;Turn off screen echos
  202.         cls             ;Clear the screen
  203.         c:\wc30\wca3x   ;Run WCA3X which is located in the HOME DIRECTORY.
  204.  
  205.  
  206. This is the exact POSTCALL.RUN file that I use and it works fine and you
  207. should have no trouble using it.
  208.  
  209.  
  210.                                                           WC Analyzer - Page 4
  211.  
  212. FINAL PROCEDURE:
  213. ================
  214.  
  215. To set the number of Calls per hours used in the Hours of Use bulletin, you
  216. need to run the program with the /rt parameter from your WC NODE Directory
  217. that contains the WCA3X.CFG file.  This will make a file called WCATIMES.TXT
  218. which will contain 8 lines of zeros and the last line will be the date and
  219. time the /rt parameter was run. The program can be run periodically with the
  220. /rt parameter to reset the calls if you like. Maybe like once a week as an
  221. event. It's up to you.
  222.  
  223. The first time WCA3X is run with NO PARAMETERS, 5 more files will be created,
  224. WC????.TXT.
  225.  
  226.  
  227. OVERVIEW:
  228. =========
  229.  
  230. Since this program does not scan the user database, it only starts compiling
  231. data as calls are terminated. Thus, only callers calling since installing
  232. this software will be recorded.
  233.  
  234. There are 6 files which are generated by WCA3X that should not be deleted.
  235. They are located in the Home Directory (WCALST10.TXT, WCACALLS.TXT,
  236. WCAMSGS.TXT, WCAULS.TXT, WCADLS.TXT and WCATIMES.TXT) and are the sort files
  237. for each bulletin.  Deleting any of these files will cause the program to
  238. start over on collecting data for the top users in each bulletin.
  239.  
  240. If you do want to start it all over again, simply delete them and it will
  241. begin the process of collecting callers all over.
  242.  
  243.  
  244. UPDATES:
  245. ========
  246.  
  247. Updates will be made available through my bulletin board and the WILDCAT
  248. support BBS. Registration will be good for all minor updates.  As we have
  249. already learned in time past, if Wildcat! goes thru a major change, this
  250. program may or may not work, but as long as they keep using the DOOR.SYS
  251. and means of shelling to DOS on a callers termination, I don't see any
  252. problems.
  253.  
  254.  
  255. CLOSING:
  256. ========
  257.  
  258. If you have any questions, please call the bulletin board on the front
  259. cover of this documentation and leave me a comment.  Any suggestions to
  260. improve this software are encouraged.
  261.  
  262. Wildcat! is a registered trademark of Mustang Software, Inc.
  263.